> For the complete documentation index, see [llms.txt](https://star-generator.gitbook.io/star-generator-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://star-generator.gitbook.io/star-generator-docs/about-stargenerator.md).

# About StarGenerator

StarGenerator is a Minecraft crafting-table plugin for custom production machines. It lets server owners define placeable table items, ModelEngine or MythicMobs table entities, custom crafting grids, rewards, energy usage, upgrades, recipe pages, recipe lists, vanilla crafting recipes, and a local WebUI editor from YAML files.

This documentation is written for StarGenerator `1.1.0`.

## What StarGenerator Provides

* Custom placeable crafting tables and machines.
* Per-table recipe pages, recipe lists, and craft method pages.
* Reward storage and output handling.
* Optional energy storage, fuel items, and energy progress bars.
* Per-table craft cost modifiers for time and energy.
* Recipe icon placeholders for craft time, energy cost, total energy, and stored machine energy.
* Central tooltip detail settings for craft progress and energy progress bars.
* Vanilla crafting recipe registration, including recipes that output StarGenerator table items.
* Starter Ice Cream content for ItemsAdder, Nexo, and Oraxen.
* ModelEngine and MythicMobs entity support with fallback interaction for missing or renamed visual models.
* Runtime cache backups, suspicious-cache quarantine, and deletion tombstones to reduce table-loss risk.
* A token-protected local WebUI editor for table, recipe, group, and pack YAML files.

## Requirements

* Java 21.
* Minecraft server API compatible with Spigot/Paper `1.21.x`.
* StarLibs is required.
* Optional integrations: PlaceholderAPI, MythicMobs, ModelEngine, ItemsAdder, Nexo, Oraxen, MMOItems.

ItemsAdder, Nexo, and Oraxen are alternative custom-item providers. Most servers should install one of them for the bundled Starter Ice Cream resources.

## Recommended Reading Order

1. Installation
2. Quick Start
3. Commands and Permissions
4. Item Paths
5. Table YAML
6. Recipe YAML
7. Energy System
8. Craft Cost Modifiers
9. Placeholders
10. WebUI Editor
11. Runtime Cache & Recovery


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://star-generator.gitbook.io/star-generator-docs/about-stargenerator.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
